<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pyswap: swap::SwapPacket::SwapPacket Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="panStamp_web.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">pyswap
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>swap</b>      </li>
      <li class="navelem"><b>SwapPacket</b>      </li>
      <li class="navelem"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html">SwapPacket</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">swap::SwapPacket::SwapPacket Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="swap::SwapPacket::SwapPacket" --><!-- doxytag: inherits="modem::CcPacket::CcPacket" -->
<p>SWAP packet class.  
 <a href="classswap_1_1SwapPacket_1_1SwapPacket.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for swap::SwapPacket::SwapPacket:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classswap_1_1SwapPacket_1_1SwapPacket.png" usemap="#swap::SwapPacket::SwapPacket_map" alt=""/>
  <map id="swap::SwapPacket::SwapPacket_map" name="swap::SwapPacket::SwapPacket_map">
<area href="classmodem_1_1CcPacket_1_1CcPacket.html" title="Standard packet structure of the CC11xx family of IC&#39;s." alt="modem::CcPacket::CcPacket" shape="rect" coords="256,0,502,24"/>
<area href="classswap_1_1SwapPacket_1_1SwapCommandPacket.html" title="SWAP Command packet class." alt="swap::SwapPacket::SwapCommandPacket" shape="rect" coords="0,112,246,136"/>
<area href="classswap_1_1SwapPacket_1_1SwapQueryPacket.html" title="SWAP Query packet class." alt="swap::SwapPacket::SwapQueryPacket" shape="rect" coords="256,112,502,136"/>
<area href="classswap_1_1SwapPacket_1_1SwapStatusPacket.html" title="SWAP status packet class." alt="swap::SwapPacket::SwapStatusPacket" shape="rect" coords="512,112,758,136"/>
</map>
 </div></div>

<p><a href="classswap_1_1SwapPacket_1_1SwapPacket-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a207182fc958403f873c4b363e3b9efd0">send</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Overriden send method.  <a href="#a207182fc958403f873c4b363e3b9efd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a145880e4e3a9772c4157f2eda46296bb">__init__</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Class constructor.  <a href="#a145880e4e3a9772c4157f2eda46296bb"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a590cad9f792f32603ef7d75a7cd7b7a7"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::srcAddress" ref="a590cad9f792f32603ef7d75a7cd7b7a7" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a590cad9f792f32603ef7d75a7cd7b7a7">srcAddress</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Source address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a100d5a381bb1099bd1bb29a79cc05076"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::destAddress" ref="a100d5a381bb1099bd1bb29a79cc05076" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a100d5a381bb1099bd1bb29a79cc05076">destAddress</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destination address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a625b2b7ba60e5474e422c72e15ec4e9c"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::hop" ref="a625b2b7ba60e5474e422c72e15ec4e9c" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a625b2b7ba60e5474e422c72e15ec4e9c">hop</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Hop count for repeating purposes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acce414fda2ff1fa80cb284bb053e2912"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::security" ref="acce414fda2ff1fa80cb284bb053e2912" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#acce414fda2ff1fa80cb284bb053e2912">security</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Security option. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a305767cff47248a056c00045668abe"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::nonce" ref="a6a305767cff47248a056c00045668abe" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a6a305767cff47248a056c00045668abe">nonce</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Security nonce. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23af64f42deab592ad6c04c7be7ce10b"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::function" ref="a23af64f42deab592ad6c04c7be7ce10b" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a23af64f42deab592ad6c04c7be7ce10b">function</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Function code. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70539c90aa9912373e30087ddd380281"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::regAddress" ref="a70539c90aa9912373e30087ddd380281" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a70539c90aa9912373e30087ddd380281">regAddress</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Register address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58cd8627fe66583a6e8aacfdcc5bf40f"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::regId" ref="a58cd8627fe66583a6e8aacfdcc5bf40f" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a58cd8627fe66583a6e8aacfdcc5bf40f">regId</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Register ID. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45114f17b47b109a67bbeb166aa0e725"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::value" ref="a45114f17b47b109a67bbeb166aa0e725" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a45114f17b47b109a67bbeb166aa0e725">value</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">SWAP value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2d5296b642b6801b5f881e272eee560"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::rssi" ref="af2d5296b642b6801b5f881e272eee560" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#af2d5296b642b6801b5f881e272eee560">rssi</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">RSSI byte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a501fb2a44fca6901d928e9b6a111134a"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::lqi" ref="a501fb2a44fca6901d928e9b6a111134a" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#a501fb2a44fca6901d928e9b6a111134a">lqi</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">LQI byte. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae486c466abfad3d922790f0ae77e94fc"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::data" ref="ae486c466abfad3d922790f0ae77e94fc" args="" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classswap_1_1SwapPacket_1_1SwapPacket.html#ae486c466abfad3d922790f0ae77e94fc">data</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">CcPacket data field. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>SWAP packet class. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a145880e4e3a9772c4157f2eda46296bb"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::__init__" ref="a145880e4e3a9772c4157f2eda46296bb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def swap::SwapPacket::SwapPacket::__init__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>ccPacket</em> = <code>None</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>destAddr</em> = <code><a class="el" href="classswap_1_1SwapDefs_1_1SwapAddress.html#a19db9df1ffbbf38ce109af469cbaa52a">SwapAddress.BROADCAST_ADDR</a></code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>hop</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>nonce</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>function</em> = <code>SwapFunction.STATUS</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>regAddr</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>regId</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>value</em> = <code>None</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Class constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ccPacket,:</td><td>Raw CcPacket where to take the information from </td></tr>
    <tr><td class="paramname">destAddr,:</td><td>Destination address </td></tr>
    <tr><td class="paramname">hop,:</td><td>Transmission hop count </td></tr>
    <tr><td class="paramname">nonce,:</td><td>Security nonce </td></tr>
    <tr><td class="paramname">function,:</td><td>SWAP function code (see <a class="el" href="classswap_1_1SwapDefs_1_1SwapFunction.html" title="SWAP function codes.">SwapDefs.SwapFunction</a> for more details) </td></tr>
    <tr><td class="paramname">regAddr,:</td><td>Register address (address of the mote where the register really resides) </td></tr>
    <tr><td class="paramname">regId,:</td><td>Register ID </td></tr>
    <tr><td class="paramname">value,:</td><td>Register value </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a207182fc958403f873c4b363e3b9efd0"></a><!-- doxytag: member="swap::SwapPacket::SwapPacket::send" ref="a207182fc958403f873c4b363e3b9efd0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def swap::SwapPacket::SwapPacket::send </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>ccModem</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Overriden send method. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">ccModem,:</td><td>modem object to be used for transmission </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classmodem_1_1CcPacket_1_1CcPacket.html#adbe064836d1ad74facbbbb2d47c7aea8">modem::CcPacket::CcPacket</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/daniel/development/Aptana/pyswap/src/swap/SwapPacket.py</li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Dec 9 2011 16:23:28 for pyswap by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
